home *** CD-ROM | disk | FTP | other *** search
/ The X-Philes (2nd Revision) / The X-Philes Number 1 (1995).iso / xphiles / hp95 / freyja.txt < prev    next >
Text File  |  1992-05-20  |  14KB  |  455 lines
  1.           (This file also appears as "freyja.txt".)
  2.  
  3.               Freyja Text Editor Overview
  4.            (Freyja Reduksjon Emacs, Ytre Jevn All)
  5.          (Freyja Reduces Emacs Yet Joins All)
  6. Version 1.4     Copyright 1991,2 by Craig A. Finseth        13 April 1992
  7.  
  8.  
  9.      This version (oh, what the heck, the whole thing) is
  10.      dedicated to my wife, Ann, and daughter, Kari, who
  11.      put up with me spending a *lot* of time on short notice
  12.      fixing the bugs in the previous version.
  13.  
  14. Sections:
  15.  
  16.     What It Is
  17.     Status
  18.     Version History
  19.     How To Obtain a Copy
  20.     How To Obtain Support
  21.     Supported Environments
  22.     Installation
  23.     File-by-File
  24.  
  25. -----------------------------------------------------------------
  26. What It Is
  27.  
  28. Freyja is an Emacs-type text editor that implements my choice of Emacs
  29. commands.  It also includes an RPN-calculator and perpetual calendar. 
  30. It is extensible by changing the source code and recompiling.  While it
  31. runs on UNIX systems, it is targeted to MS/DOS laptop and palmtop
  32. machines.
  33.  
  34. As a text editor, Freyja includes the following features:
  35.  
  36.     - full range of character, line, word, sentence, and
  37.     paragraph-oriented commands.
  38.     - search, replace, and query replace
  39.     - deletions are automatically saved into a "kill buffer"
  40.     - ability to edit up to 11 files at once
  41.     - ability to view two windows at once
  42.     - integrated help facility
  43.     - commands to change the case of text, change indentation,
  44.     and perform many other functions
  45.     - can record and play back keyboard macros
  46.     - includes a perpetual calendar
  47.     - includes a fully-integrated HP-45A type calculator
  48.     - configurable with a FREYJA.INI file
  49.     - system-manager compliant version for the HP95LX
  50.  
  51. -----------------------------------------------------------------
  52. Status:
  53.  
  54. With the exception of two files, the entire release is freeware
  55. distributed under the same terms as GNU CopyLeft.
  56.  
  57. The two files are c0s.asm and makeexm.c.  These files are placed
  58. wholly in the public domain and anyone, anywhere can use them for any
  59. purpose in any way.  It is silly to make others have to reinvent this
  60. particular wheel.  Please use them with my blessings.
  61.  
  62. There is still a pesky bug in the MS/DOS version.  (It does not appear
  63. to be present in the Unix or HP95LX system-manager compliant
  64. versions.)  If you edit a lot -- especially interrupting redisplay --
  65. and exit, it (randomly) hangs at the call to _exit.  Of course, I
  66. can't make it happen whenever I try to find and fix it...
  67.  
  68. -----------------------------------------------------------------
  69. Version History:
  70.  
  71. 1.1     3 Aug 1991    first release
  72. 1.2    15 Aug 1991    second release: minor bug fixes in ^C, ^[ ^E,
  73.             Ins, Enter (in calculator) and redisplay;
  74.             added keyboard switch
  75. 1.3    21 Mar 1992    third release: reworked .ini file reading, fixed
  76.             minor bugs; ^X ^D now includes hidden files; file
  77.             I/O can now be unprocessed; all columns of the
  78.             screen are now used; ^U ^W doesn't save deleted
  79.             text; removed the date/time stamp command and
  80.             date time format support; created system-manager
  81.             compliant versions
  82.  
  83. 1.4    13 Apr 1992    ^X^F now checks for read errors; fixed a bizzarre
  84.             bug in the system-manager compliant version (forgot
  85.             to remove a call to malloc/free); fixed buffer
  86.             deletion bug (now can't delete scratch);
  87.             file getter now works like other s-m applications;
  88.             added SBUffer, CTX swap, LANguage, SAVing options
  89.             to freyja.ini; ^G now cancels menu and file getter
  90.             (like ESC) in system-manager version; fixed a bug
  91.             in the Help screen; moved the filename to the end
  92.             of the status line; fixed a word wrap bug
  93.  
  94. -----------------------------------------------------------------
  95. How To Obtain a Copy:
  96.  
  97. Diskette: Send the author blank diskettes:
  98.  
  99.     - two, 5 1/4" (360 KB) or
  100.     - one, 3 1/2" (either 720 KB or 1.44 MB)
  101.  
  102. and enough stamps to cover return postage plus a dollar or so (so that
  103. I can buy a diskette mailer).  Or you can just send me about US$3.00
  104. in check, stamp, whatever and I will furnish the diskette(s) and
  105. mailer.
  106.  
  107. Anonymous FTP:
  108.     mail.unet.umn.edu in
  109.         import/fin/freyja.exe    (MS/DOS self-extracting archive)
  110.         import/fin/freyja.tar    (UNIX tar file)
  111.         import/fin/freyja.tar.Z    (compressed UNIX tar file)
  112.         import/fin/freyja.txt    (README file)
  113.     eddie.mit.edu
  114.         distrib/hp95lx/editors/freya.tar.Z
  115.         distrib/hp95lx/editors/freya.exe
  116.  
  117. -----------------------------------------------------------------
  118. How To Obtain Support:
  119.  
  120.     not supported, author is:
  121.  
  122.     Craig Finseth
  123.     1343 Lafond
  124.     St Paul MN 55104
  125.     USA
  126.  
  127.     +1 612 644 4027
  128.  
  129.     fin@unet.umn.edu
  130.     Craig.Finseth@nic.mr.net
  131.  
  132. -----------------------------------------------------------------
  133. Supported Environments:
  134.  
  135.     Tested on SunOs 4.0.3.
  136.     Should run under most Berkeley Unix environments.
  137.  
  138.     Tested on MS/DOS V3.x and should run on any MS/DOS version 2.0
  139.     or later system.  Requires Borland Turbo C Version 2.0 or
  140.     later to compile (it should compile and run under Microsoft C
  141.     with only minor changes).
  142.  
  143.     Tested on HP95LX.
  144.  
  145. -----------------------------------------------------------------
  146. Installation #1 (from diskette, for MS/DOS):
  147.  
  148. 1) Create a directory on the MS/DOS system to hold the files.
  149. 2) Copy the freyja files from the diskette(s) to this directory.
  150.  
  151.     copy a:*.*
  152.  
  153. 3) Install it, do:
  154.  
  155.     copy freyja.exe [[whereever you put executables]]
  156.  
  157. 4) Install the documentation files. Consult freyja.doc for search path
  158. information.  These are only requied for the help functions; the editor
  159. works fine for all other purposes without them.
  160.  
  161.     copy f*.doc [[somewhere in the search path]]
  162.  
  163. 5) If you just want to run the regular versions, stop here.
  164.  
  165.     -> see Installation #5 for installing in the HP95LX
  166.  
  167. If you want to make a new version:
  168.  
  169. 6) In fgenlib.h, make sure that the correct system constant is #defined.
  170. 7) Edit turboc.cfg to suit your system.
  171. 8) Make it:
  172.  
  173.     copy makefile.msd makefile
  174.     [[edit makefile to select the regular or system-manager compliant
  175.         version]]
  176.     make
  177.  
  178. -----------------------------------------------------------------
  179. Installation #2 (from freyja.exe file, for MS/DOS):
  180.  
  181. 1) Be on an MS/DOS host or one that can run MS/DOS executables.
  182. 2) Create a directory to hold the files.
  183. 3) Put the FREYJA.EXE file in some >>other<< directory, as things
  184. might get dicey when it tries to unpack FREYJA.EXE...
  185. 4) Do:
  186.  
  187.     cd [[the destination directory]]
  188.     [[the name of the freyja.exe file on your system]]
  189.  
  190. 5) Follow the steps in installation #1 starting with step 3.
  191.  
  192. -----------------------------------------------------------------
  193. Installation #3 (from freyja.tar file, for MS/DOS):
  194.  
  195. 1) Be on a Unix host or one with a tar command.
  196. 2) Create a directory to hold the files.
  197. 3) Do:
  198.  
  199.     cd [[that directory]]
  200.     tar xvf [[the name of the freyja.tar file on your system]]
  201.  
  202. 4) Transfer the files to an MS/DOS system.  Don't forget that
  203. freyja.exe and freyja.exm must be transferred in "binary" mode.
  204. 5) Follow the steps in installation #1 starting with step 3.
  205.  
  206. -----------------------------------------------------------------
  207. Installation #4 (from freyja.tar.Z file, for MS/DOS):
  208.  
  209. 1) Be on a Unix host or one with uncompress and tar commands.
  210. 2) Create a directory to hold the files.
  211. 3) Do:
  212.  
  213.     cd [[that directory]]
  214.     uncompress < [[the name of the freyja.tar.Z file on your system]] |
  215.         tar xvf - 
  216.  
  217. 4) Transfer the files to an MS/DOS system.  Don't forget that
  218. freyja.exe and freyja.exm must be transferred in "binary" mode.
  219. 5) Follow the steps in installation #1 starting with step 3.
  220.  
  221. -----------------------------------------------------------------
  222. Installation #5 (from diskette or .tar files, for HP95LX):
  223.  
  224. 1) Obtain an IBM PC version.  Note that the FREYJA.EXE and  FREYJA.EXM
  225. files are included with the distribution, so that you don't have to
  226. compile anything if you just want to run the off-the-shelf versions.
  227.  
  228. 2) Set up a FREYJA.INI file.  You can either create it on a PC and
  229. download or use the MEMO application.  Mine looks like this:
  230.  
  231.     swa 40
  232.     spe j
  233.     pa1 p    [[optional, turns off serial port power while
  234.         in Freyja, then on upon exiting]]
  235.     met i    [[optional]]
  236.     use n    [[optional]]
  237.     wra y    [[optional]]
  238.     sbu n    [[optional]]
  239.     lan 1    [[optional]]
  240.  
  241. See the distribution FREYJA.INI file for explanations of these
  242. options.  The same file can be used for both the versions: the
  243. system-manager compliant version ignores any parameters that don't
  244. apply.
  245.  
  246. I put this file in the C:\_DAT directory.
  247.  
  248. 3) If you want to use the system-manager compliant version:
  249.  
  250.     3A) Load FREYJA.EXM into the HP95LX.
  251.  
  252.     3B) The minimum system RAM required is 218K.  This number
  253.     assumes a 40K swap area, and no other applications open or
  254.     other uses of memory.
  255.  
  256.     3C) Create or add to your C:\_DAT\APNAME.LST file.  Here is
  257.     an example entry that uses the Alt-MEMO key:
  258.  
  259.         C:\_DAT\FREYJA.EXM,bb00,Freyja^M
  260.  
  261.     Or, if you are like me:
  262.  
  263.         C:\_DAT\FREYJA.EXM,b800,Freyja^M
  264.  
  265.     And thus override the built-in MEMO function.
  266.  
  267.     The first field if the full pathname of the .EXM file.  It
  268.     must be in upper case, and the drive letter (e.g. "C:") must
  269.     be the same drive as the APNAME.LST file.  The second field is
  270.     the scan code of the hot key.  The third field is the name. 
  271.     The whole thing is terminated by a Carriage Return.
  272.  
  273.     key        base    w/Ctrl    w/Alt
  274.  
  275.     FILER        a800    ae00    ab00
  276.     COMM        ac00    b200    af00
  277.     APPT        b000    b600    b300
  278.     PHONE        b400    ba00    b700
  279.     MEMO        b800    be00    bb00
  280.     123        bc00    c200    bf00
  281.     CALC        c000    c600    c300
  282.  
  283.     Don't forget to reboot the HP95LX.
  284.  
  285. 4) If you want to use the regular version:
  286.  
  287.     4A) Load FREYJA.EXE into the HP95LX.
  288.  
  289.     4B) The minimum system RAM required is 282K.  This number
  290.     assumes a 40K swap area, and no other applications open or
  291.     other uses of memory.
  292.  
  293.     4C) Instead of setting the swap area size in FREYJA.INI,
  294.     you could run a DOS shell (MENU S in the FILER) and  give
  295.     this command line:
  296.  
  297.         freyja -z 40
  298.  
  299.     But this is more work as you have to do it each time.
  300.  
  301.     4D) A typical configuration is to put FREYJA.EXE in C:\ and
  302.     FREYJA.INI in C:\_DAT.  To make this work, do:
  303.  
  304.     create or add to CONFIG.SYS:
  305.  
  306.         shell=command /p
  307.  
  308.     create or add to AUTOEXEC.BAT:
  309.  
  310.         set FREYJADIR=C:\_DAT
  311.         $SYSMGR
  312.  
  313.     Then reboot.
  314.  
  315. -----------------------------------------------------------------
  316. Installation #6 (from freyja.tar file, for UNIX):
  317.  
  318. 1) Be on a Unix host or one with a tar command.
  319. 2) Create a directory to hold the files.
  320. 3) Do:
  321.  
  322.     cd [[that directory]]
  323.     tar xvf [[the name of the freyja.tar file on your system]]
  324.  
  325. 4) In fgenlib.h, make sure that the correct system constant is #defined.
  326. 5) Configure the editor (look at the beginning of freyja.h).
  327. 6) Make it:
  328.  
  329.     mv Makefile.unx Makefile
  330.     make
  331.  
  332. 7) Install it, do:
  333.  
  334.     cp freyja [[your binary directory, /usr/local/bin?]]
  335.  
  336. 8) Install the documentation files. Consult freyja.doc for search path
  337. information.  These are only requied for the help functions; the editor
  338. works fine for all other purposes without them.
  339.  
  340.     cp f*.doc [[somewhere in the search path]]
  341.  
  342. 9) If desired, change freyja.ini, then put this default version
  343. somewhere in the search path.
  344.  
  345. -----------------------------------------------------------------
  346. Installation #7 (from freyja.tar.Z file, for UNIX):
  347.  
  348. 1) Be on a Unix host or one with uncompress and tar commands.
  349. 2) Create a directory to hold the files.
  350. 3) Do:
  351.  
  352.     cd [[that directory]]
  353.     uncompress < [[the name of the freyja.tar.Z file on your system]] |
  354.         tar xvf - 
  355.  
  356. 4) Follow the steps in installation #6 starting with step 4.
  357.  
  358. -----------------------------------------------------------------
  359. Installation #8 (from diskette, for UNIX):
  360.  
  361. 1) Create a directory to hold the files.
  362. 2) Copy the freyja files from the diskette(s) to this directory.  How
  363. you do this varies from system to system.
  364. 3) Follow the steps in installation #6 starting with step 4.
  365.  
  366. -----------------------------------------------------------------
  367. File-by-File:
  368.  
  369. makefile.msd    MS/DOS Makefile
  370. Makefile.unx    UNIX Makefile
  371.  
  372. README        this file
  373.  
  374. ascii        ASCII chart
  375.  
  376. buf.c        buffer management routines
  377.  
  378. c0s.asm        replacement startup code for use with the system-manager
  379.         compliant version
  380.  
  381. calc.c        calculator routines
  382.  
  383. char.c        character-, line-, and screen-oriented commands
  384.  
  385. date.c        date arithmetic routines
  386.  
  387. display.c    display and display output routines
  388.  
  389. fcalc.doc    calculator documentation
  390. fcmdlist.doc    command list
  391. fcmdxref.doc    command cross reference
  392. fcopying.doc    copying information
  393. ffsf.doc    Free Software Foundation information
  394.  
  395. fgenlib.h     General library header file.
  396.  
  397. file.c        file-, buffer-, and system-oriented commands
  398.  
  399. fleague.doc    League for Programmer Freedom information
  400.  
  401. flib.c        General library routines
  402.  
  403. freyja.c    top level
  404.  
  405. freyja.doc    documentation, such as it is
  406.  
  407. freyja.exe    MS/DOS executable, regular
  408. freyja.exm    MS/DOS executable, system-manager compliant
  409.  
  410. freyja.h    main include file
  411.  
  412. freyja.ini    template for .ini file
  413.  
  414. freyja.lnk    MS/DOS linker directive file
  415.  
  416. ftutoria.doc    introductory tutorial
  417.  
  418. fwarrant.doc    warranty information
  419.  
  420. help.c        help stuff
  421.  
  422. ini.c        load the initialization file
  423.  
  424. jaguar.c    HP95LX (Jaguar) interface routines
  425.  
  426. key.c        keyboard and input routines
  427.  
  428. libasm.asm    MS/DOS assembly language interface routines
  429.  
  430. makeexm.c    MS/DOS source to the makeexm program, which builds a .EXM file
  431.  
  432. misc.c        miscellaneous commands
  433.  
  434. region.c    region-oriented commands
  435.  
  436. smfreyja.lnk    MS/DOS linker directive file for the system-manager compliant
  437.         version
  438.  
  439. smjaguar.c    HP95LX (Jaguar) interface routines for the system-manager
  440.         compliant version
  441.  
  442. table.c        command table routines
  443.  
  444. term.c        terminal interface routines
  445.  
  446. turboc.cfg    MS/DOS Turbo C configuration file
  447.  
  448. white.c        whitespace-oriented commands
  449.  
  450. word.c        word-oriented commands (including sentence, number,
  451.         and paragraph)
  452.  
  453. xprintf.c    replacement/supplement for printf
  454. xprintf.doc
  455.